Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[Dataset] Add take, filter API to dataset #16078

Merged
merged 7 commits into from
Sep 8, 2019

Conversation

eric-haibin-lin
Copy link
Member

Description

Add dataset.filter, dataset.take APIs. @zhreshold

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

Copy link
Member

@szha szha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new APIs would have quite a bit of overlap with the existing sampler API. An alternative would be a sample interface that takes a sampler.

@eric-haibin-lin
Copy link
Member Author

Then the Sampler needs to take a dataset as the input for its constructor, which is quite different from existing samplers. Do we really want to do that?
We also need more functionalities like concat, reduce and window (ref: https://www.tensorflow.org/api_docs/python/tf/data/Dataset#concatenate) which will be separate APIs and cannot be expressed as sampling.

@zhreshold
Copy link
Member

this one looks good to me, just wanna confirm if it's compatible with LazyTransform dataset?

@eric-haibin-lin
Copy link
Member Author

yes. I added more tests with lazy transform dataset.

python/mxnet/gluon/data/dataset.py Outdated Show resolved Hide resolved
@@ -40,6 +40,41 @@ def __getitem__(self, idx):
def __len__(self):
raise NotImplementedError

def filter(self, fn):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will eagerly retrieve all values from a lazy=True transformed dataset. That should be documented?
(The transformation function will also be applied again in __getitem__)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I'll document that

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it better in some cases that lazy evaluation should be applied after filter, i.e.,

data.filter(xxx).transform is way better than data.transform.filter in some situations.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both are valid operations and I don't think we can stop users from doing transform() before filter(), since sometimes we need to actually filter the data based on the transformed data. For now I'd resort to better documentation

@eric-haibin-lin eric-haibin-lin merged commit 27a9782 into apache:master Sep 8, 2019
larroy pushed a commit to larroy/mxnet that referenced this pull request Sep 28, 2019
* first commit

* fix lint

* add more test  for transformed data

* address CR

* Update dataset.py

* use sampler to implement

* Update dataset.py
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants